home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tcl / ExprLong.man < prev    next >
Encoding:
Text File  |  1992-08-07  |  7.3 KB  |  278 lines
  1. '\"
  2. '\" Copyright 1989 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/tcl/man/RCS/ExprLong.man,v 1.5 92/03/28 14:21:09 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS Tcl_ExprLong tcl
  189. .BS
  190. .SH NAME
  191. Tcl_ExprLong, Tcl_ExprDouble, Tcl_ExprBool, Tcl_ExprString \- evaluate an expression
  192. .SH SYNOPSIS
  193. .nf
  194. \fB#include <tcl.h>\fR
  195. .VS
  196. .sp
  197. int
  198. \fBTcl_ExprLong\fR(\fIinterp, string, longPtr\fR)
  199. .sp
  200. int
  201. \fBTcl_ExprDouble\fR(\fIinterp, string, doublePtr\fR)
  202. .sp
  203. int
  204. \fBTcl_ExprBoolean\fR(\fIinterp, string, booleanPtr\fR)
  205. .sp
  206. int
  207. \fBTcl_ExprString\fR(\fIinterp, string\fR)
  208. .SH ARGUMENTS
  209. .AS Tcl_Interp *booleanPtr
  210. .AP Tcl_Interp *interp in
  211. Interpreter in whose context to evaluate \fIstring\fR.
  212. .AP char *string in
  213. Expression to be evaluated.  Must be in writable memory (the expression
  214. parser makes temporary modifications to the string during parsing, which
  215. it undoes before returning).
  216. .AP long *longPtr out
  217. Pointer to location in which to store the integer value of the
  218. expression.
  219. .AP int *doublePtr out
  220. Pointer to location in which to store the floating-point value of the
  221. expression.
  222. .AP int *booleanPtr out
  223. Pointer to location in which to store the 0/1 boolean value of the
  224. expression.
  225. .BE
  226.  
  227. .SH DESCRIPTION
  228. .PP
  229. These four procedures all evaluate a string expression, returning
  230. the result in one of four different forms.
  231. The expression is given by the \fIstring\fR argument, and it
  232. can have any of the forms accepted by the \fBexpr\fR command.
  233. The \fIinterp\fR argument refers to an interpreter used to
  234. evaluate the expression (e.g. for variables and nested Tcl
  235. commands) and to return error information.  \fIInterp->result\fR
  236. is assumed to be initialized in the standard fashion when any
  237. of the procedures are invoked.
  238. .PP
  239. For all of these procedures the return value is a standard
  240. Tcl result:  \fBTCL_OK\fR means the expression was succesfully
  241. evaluated, and \fBTCL_ERROR\fR means that an error occurred while
  242. evaluating the expression.  If \fBTCL_ERROR\fR is returned then
  243. \fIinterp->result\fR will hold a message describing the error.
  244. If an error occurs while executing a Tcl command embedded in
  245. \fIstring\fR, then that error will be returned.
  246. .PP
  247. If the expression is successfully evaluated, then its value will
  248. be returned in one of four forms, depending on which procedure
  249. is invoked.
  250. \fBTcl_ExprLong\fR stores an integer value at \fI*longPtr\fR.
  251. If the expression's actual value was a floating-point number,
  252. then it is truncated to an integer.
  253. If the expression's actual value was a non-numeric string then
  254. an error is returned.
  255. .PP
  256. \fBTcl_ExprDouble\fR stores a floating-point value at \fI*doublePtr\fR.
  257. If the expression's actual value was an integer, it is converted to
  258. floating-point.
  259. If the expression's actual value was a non-numeric string then
  260. an error is returned.
  261. .PP
  262. \fBTcl_ExprBoolean\fR stores a 0/1 integer value at \fI*booleanPtr\fR.
  263. If the expression's actual value was an integer or floating-point
  264. number, then \fBTcl_ExprBoolean\fR stores 0 at \fI*booleanPtr\fR if
  265. the value was zero and 1 otherwise.
  266. If the expression's actual value was a non-numeric string then
  267. an error is returned.
  268. .PP
  269. \fBTcl_ExprString\fR returns the value of the expression as a
  270. string stored in \fIinterp->result\fR.
  271. If the expression's actual value was an integer or floating-point
  272. number, then \fBTcl_ExprString\fR converts it to string (using \fBsprintf\fR
  273. with a ``%d'' or ``%g'' converter).
  274.  
  275. .SH KEYWORDS
  276. boolean, double, evaluate, expression, integer, string
  277. .VE
  278.